<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: session/app.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_938858dd290fe54e59e3500689c41d32.html">session</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">app.cpp</div></div>
</div><!--header-->
<div class="contents">
<a href="app_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Sessions</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#include &quot;<a class="code" href="app_8hpp.html">ipc/session/app.hpp</a>&quot;</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="preprocessor">#include &quot;<a class="code" href="session__fwd_8hpp.html">ipc/session/session_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="ipc__session_2src_2ipc_2session_2error_8hpp.html">ipc/session/error.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="native__handle_8hpp.html">ipc/util/native_handle.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &lt;flow/error/error.hpp&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &lt;sys/stat.h&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="namespaceipc_1_1session.html">   26</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1session.html">ipc::session</a></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span>{</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment">// Implementations.</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="namespaceipc_1_1session.html#a0eac87b284d50832334d819a8877cbaa">   31</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceipc_1_1session.html#a0eac87b284d50832334d819a8877cbaa">ensure_resource_owner_is_app</a>(flow::log::Logger* logger_ptr, <span class="keyword">const</span> fs::path&amp; path, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1App.html">App</a>&amp; app,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>                                  <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code)</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>{</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>  <span class="keyword">using </span><a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">util::Native_handle</a>;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>  <span class="keyword">using </span>boost::system::system_category;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>  using ::open;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>  using ::close;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span>  <span class="comment">// using ::O_PATH; // It&#39;s a macro apparently.</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span>  <span class="comment">// using ::errno; // It&#39;s a macro apparently.</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span>  <span class="keywordflow">if</span> (flow::error::exec_void_and_throw_on_error</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span>        ([&amp;](<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* actual_err_code)</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>           { <a class="code hl_function" href="namespaceipc_1_1session.html#a0eac87b284d50832334d819a8877cbaa">ensure_resource_owner_is_app</a>(logger_ptr, path, app, actual_err_code); },</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>         err_code, <span class="stringliteral">&quot;session::ensure_resource_owner_is_app(1)&quot;</span>))</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>  {</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span>    <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>  }</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>  <span class="comment">// else</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span>  FLOW_LOG_SET_CONTEXT(logger_ptr, Log_component::S_SESSION);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>  <span class="comment">/* We can either reuse the handle-based overload, or we can do stat() instead of fstat().  The former seems nicer;</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment">   * though we&#39;ll have to open a handle temporarily.  I&#39;ve seen boost.interprocess do it fairly casually for</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment">   * similar purposes, so why not.  The O_PATH flag (which opens the resource just for this purpose -- not for</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment">   * I/O) is perfect for it, particularly since the resource might not be a file but a SHM pool, etc. */</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span>  <span class="keywordtype">int</span> native_handle = open(path.c_str(), O_PATH);</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>  <span class="keywordflow">if</span> (native_handle == -1)</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>  {</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span>    *err_code = <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>(errno, system_category());</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span>    FLOW_LOG_WARNING(<span class="stringliteral">&quot;Tried to check ownership of resource at [&quot;</span> &lt;&lt; path &lt;&lt; <span class="stringliteral">&quot;] but while obtaining info-only handle &quot;</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span>                     <span class="stringliteral">&quot;encountered error [&quot;</span> &lt;&lt; *err_code &lt;&lt; <span class="stringliteral">&quot;] [&quot;</span> &lt;&lt; err_code-&gt;message() &lt;&lt; <span class="stringliteral">&quot;]; unable to check.&quot;</span>);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span>    <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span>  }</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span>  <span class="comment">// else</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span>  <a class="code hl_typedef" href="namespaceipc_1_1transport.html#a7ee4551983d9df16ec16a3139bac50e8">Native_handle</a> handle(native_handle);</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span>  <span class="comment">// For nicer messaging add some more logging on error.  A little code duplication, but it&#39;s OK.</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span>  <a class="code hl_function" href="namespaceipc_1_1session.html#a0eac87b284d50832334d819a8877cbaa">ensure_resource_owner_is_app</a>(logger_ptr, handle, app, err_code);</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span>  <span class="keywordflow">if</span> (*err_code)</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span>  {</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span>    FLOW_LOG_WARNING(<span class="stringliteral">&quot;Check of ownership of resource at [&quot;</span> &lt;&lt; path &lt;&lt; <span class="stringliteral">&quot;], upon successfully opening probe-only &quot;</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span>                     <span class="stringliteral">&quot;descriptor/handle, resulted in error in checking or &quot;</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span>                     <span class="stringliteral">&quot;unexpected ownership; see preceding WARNING referencing all other details.&quot;</span>);</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span>  }</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span>  close(native_handle);</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span>} <span class="comment">// ensure_resource_owner_is_app(1)</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span> </div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"><a class="line" href="namespaceipc_1_1session.html#ac7f0052fa0537c3696063693644bcff8">   80</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceipc_1_1session.html#a0eac87b284d50832334d819a8877cbaa">ensure_resource_owner_is_app</a>(flow::log::Logger* logger_ptr, <a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">util::Native_handle</a> handle, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1App.html">App</a>&amp; app,</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span>                                  <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code)</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span>{</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span>  <span class="keyword">using </span>boost::system::system_category;</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span>  using ::fstat;</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span>  <span class="comment">/* using Stats = struct ::stat; // This worked at coliru.com but not here; not sure why.</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment">   *                              // The crux of this whole thing is that struct ::stat() and ::stat()</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment">   *                              // have the same name.  Blech.  Just specify it explicitly below, C-style. */</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span>  <span class="comment">// using ::errno; // It&#39;s a macro apparently.</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span>  <span class="keywordflow">if</span> (flow::error::exec_void_and_throw_on_error</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span>        ([&amp;](<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* actual_err_code)</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span>           { <a class="code hl_function" href="namespaceipc_1_1session.html#a0eac87b284d50832334d819a8877cbaa">ensure_resource_owner_is_app</a>(logger_ptr, handle, app, actual_err_code); },</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span>         err_code, <span class="stringliteral">&quot;session::ensure_resource_owner_is_app(2)&quot;</span>))</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span>  {</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span>    <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span>  }</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span>  <span class="comment">// else</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span> </div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span>  assert((!handle.<a class="code hl_function" href="structipc_1_1util_1_1Native__handle.html#a11bd62ce0a7bef4bdfe666201c26d4dc">null</a>()) &amp;&amp; <span class="stringliteral">&quot;Disallowed per contract.&quot;</span>);</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span>  FLOW_LOG_SET_CONTEXT(logger_ptr, Log_component::S_SESSION);</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span> </div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span>  <span class="comment">// There&#39;s no Boost.filesystem or STL way to get UID/GID, that I know of (even via path); so use POSIX-y thing.</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span>  struct ::stat stats;</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span>  <span class="keyword">const</span> <span class="keyword">auto</span> rc = fstat(handle.<a class="code hl_variable" href="structipc_1_1util_1_1Native__handle.html#ab2f496740139c5752a25a30cf3325d86">m_native_handle</a>, &amp;stats);</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span>  <span class="keywordflow">if</span> (rc == -1)</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span>  {</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span>    *err_code = <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>(errno, system_category());</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span>    FLOW_LOG_WARNING(<span class="stringliteral">&quot;Tried to check ownership via descriptor/handle [&quot;</span> &lt;&lt; handle &lt;&lt; <span class="stringliteral">&quot;] but encountered &quot;</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span>                     <span class="stringliteral">&quot;error [&quot;</span> &lt;&lt; *err_code &lt;&lt; <span class="stringliteral">&quot;] [&quot;</span> &lt;&lt; err_code-&gt;message() &lt;&lt; <span class="stringliteral">&quot;]; unable to check.&quot;</span>);</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span>  }</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span>  <span class="keywordflow">else</span> <span class="keywordflow">if</span> ((stats.st_uid != app.<a class="code hl_variable" href="structipc_1_1session_1_1App.html#a9e32297579603f2d96616976474d0246">m_user_id</a>) || (stats.st_gid != app.<a class="code hl_variable" href="structipc_1_1session_1_1App.html#a78bb1e984835f429fd44869a83f4b093">m_group_id</a>))</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span>  {</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span>    *err_code = <a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa5c437fa266aea0c8e2b348ee84dd61fa">error::Code::S_RESOURCE_OWNER_UNEXPECTED</a>;</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span>    FLOW_LOG_WARNING(<span class="stringliteral">&quot;Checked ownership via descriptor/handle [&quot;</span> &lt;&lt; handle &lt;&lt; <span class="stringliteral">&quot;] but encountered &quot;</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span>                     <span class="stringliteral">&quot;error [&quot;</span> &lt;&lt; *err_code &lt;&lt; <span class="stringliteral">&quot;] [&quot;</span> &lt;&lt; err_code-&gt;message() &lt;&lt; <span class="stringliteral">&quot;]; unable to check.&quot;</span>);</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span>  }</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span>  <span class="keywordflow">else</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span>  {</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span>    err_code-&gt;clear();</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span>  }</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span>} <span class="comment">// ensure_resource_owner_is_app(2)</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span> </div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"><a class="line" href="structipc_1_1session_1_1App.html#a6b2f9a90ac9cc5098d9b90e7f547c97e">  124</a></span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1session.html#a6b2f9a90ac9cc5098d9b90e7f547c97e">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1App.html">App</a>&amp; val)</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span>{</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span>  <span class="keywordflow">return</span> os &lt;&lt; <span class="charliteral">&#39;[&#39;</span> &lt;&lt; val.<a class="code hl_variable" href="structipc_1_1session_1_1App.html#a8e67b57829fe43a122a23c699b5de8fd">m_name</a> &lt;&lt; <span class="stringliteral">&quot;] &quot;</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span>               <span class="stringliteral">&quot;exec[&quot;</span> &lt;&lt; val.<a class="code hl_variable" href="structipc_1_1session_1_1App.html#ae82a8635858664720c8546e468f8090b">m_exec_path</a> &lt;&lt; <span class="stringliteral">&quot;] user[&quot;</span> &lt;&lt; val.<a class="code hl_variable" href="structipc_1_1session_1_1App.html#a9e32297579603f2d96616976474d0246">m_user_id</a> &lt;&lt; <span class="charliteral">&#39;:&#39;</span> &lt;&lt; val.<a class="code hl_variable" href="structipc_1_1session_1_1App.html#a78bb1e984835f429fd44869a83f4b093">m_group_id</a> &lt;&lt; <span class="charliteral">&#39;]&#39;</span>;</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span>}</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"><a class="line" href="structipc_1_1session_1_1Client__app.html#a0e786447d51449f1249c10e127ab10e2">  129</a></span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1session.html#a6b2f9a90ac9cc5098d9b90e7f547c97e">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Client__app.html">Client_app</a>&amp; val)</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span>{</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span>  <span class="keywordflow">return</span> os &lt;&lt; static_cast&lt;const App&amp;&gt;(val);</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span>}</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span> </div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"><a class="line" href="structipc_1_1session_1_1Server__app.html#a34a03a25908100446b3eca2e8dca61fe">  134</a></span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1session.html#a6b2f9a90ac9cc5098d9b90e7f547c97e">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Server__app.html">Server_app</a>&amp; val)</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span>{</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span>  <span class="keyword">using </span>boost::algorithm::join;</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span> </div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span>  <span class="keywordflow">return</span> os &lt;&lt; static_cast&lt;const App&amp;&gt;(val) &lt;&lt; <span class="stringliteral">&quot; allowed_cli_apps[&quot;</span> &lt;&lt; join(val.<a class="code hl_variable" href="structipc_1_1session_1_1Server__app.html#a12df649b33893270afeac7240a571633">m_allowed_client_apps</a>, <span class="stringliteral">&quot; &quot;</span>) &lt;&lt; <span class="charliteral">&#39;]&#39;</span>;</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span>}</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span> </div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span>} <span class="comment">// namespace ipc::session</span></div>
<div class="ttc" id="aapp_8hpp_html"><div class="ttname"><a href="app_8hpp.html">app.hpp</a></div></div>
<div class="ttc" id="aipc__session_2src_2ipc_2session_2error_8hpp_html"><div class="ttname"><a href="ipc__session_2src_2ipc_2session_2error_8hpp.html">error.hpp</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_a0708d4bec9ae853f4d7e3d7822fc8f2fa5c437fa266aea0c8e2b348ee84dd61fa"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa5c437fa266aea0c8e2b348ee84dd61fa">ipc::session::error::Code::S_RESOURCE_OWNER_UNEXPECTED</a></div><div class="ttdeci">@ S_RESOURCE_OWNER_UNEXPECTED</div><div class="ttdoc">A resource in the file system (file, SHM pool, MQ, etc.) has or could have unexpected owner; ipc::ses...</div></div>
<div class="ttc" id="anamespaceipc_1_1session_html"><div class="ttname"><a href="namespaceipc_1_1session.html">ipc::session</a></div><div class="ttdoc">Flow-IPC module providing the broad lifecycle and shared-resource organization – via the session conc...</div><div class="ttdef"><b>Definition:</b> <a href="app_8cpp_source.html#l00026">app.cpp:27</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_html_a0eac87b284d50832334d819a8877cbaa"><div class="ttname"><a href="namespaceipc_1_1session.html#a0eac87b284d50832334d819a8877cbaa">ipc::session::ensure_resource_owner_is_app</a></div><div class="ttdeci">void ensure_resource_owner_is_app(flow::log::Logger *logger_ptr, const fs::path &amp;path, const App &amp;app, Error_code *err_code)</div><div class="ttdoc">Utility, used internally but exposed in public API in case it is of general use, that checks that the...</div><div class="ttdef"><b>Definition:</b> <a href="app_8cpp_source.html#l00031">app.cpp:31</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_html_a6b2f9a90ac9cc5098d9b90e7f547c97e"><div class="ttname"><a href="namespaceipc_1_1session.html#a6b2f9a90ac9cc5098d9b90e7f547c97e">ipc::session::operator&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, const App &amp;val)</div><div class="ttdoc">Prints string representation of the given App to the given ostream.</div><div class="ttdef"><b>Definition:</b> <a href="app_8cpp_source.html#l00124">app.cpp:124</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_html_a7ee4551983d9df16ec16a3139bac50e8"><div class="ttname"><a href="namespaceipc_1_1transport.html#a7ee4551983d9df16ec16a3139bac50e8">ipc::transport::Native_handle</a></div><div class="ttdeci">util::Native_handle Native_handle</div><div class="ttdoc">Convenience alias for the commonly used type util::Native_handle.</div><div class="ttdef"><b>Definition:</b> <a href="transport__fwd_8hpp_source.html#l00081">transport_fwd.hpp:81</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa3192e586cc45d3e7c22463bf2760f89"><div class="ttname"><a href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">ipc::Error_code</a></div><div class="ttdeci">flow::Error_code Error_code</div><div class="ttdoc">Short-hand for flow::Error_code which is very common.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00298">common.hpp:298</a></div></div>
<div class="ttc" id="anative__handle_8hpp_html"><div class="ttname"><a href="native__handle_8hpp.html">native_handle.hpp</a></div></div>
<div class="ttc" id="asession__fwd_8hpp_html"><div class="ttname"><a href="session__fwd_8hpp.html">session_fwd.hpp</a></div></div>
<div class="ttc" id="astructipc_1_1session_1_1App_html"><div class="ttname"><a href="structipc_1_1session_1_1App.html">ipc::session::App</a></div><div class="ttdoc">A description of an application in this ipc::session inter-process communication universe.</div><div class="ttdef"><b>Definition:</b> <a href="app_8hpp_source.html#l00077">app.hpp:78</a></div></div>
<div class="ttc" id="astructipc_1_1session_1_1App_html_a78bb1e984835f429fd44869a83f4b093"><div class="ttname"><a href="structipc_1_1session_1_1App.html#a78bb1e984835f429fd44869a83f4b093">ipc::session::App::m_group_id</a></div><div class="ttdeci">util::group_id_t m_group_id</div><div class="ttdoc">The application must run as this group ID (GID). Files and other shared resources shall have this own...</div><div class="ttdef"><b>Definition:</b> <a href="app_8hpp_source.html#l00171">app.hpp:171</a></div></div>
<div class="ttc" id="astructipc_1_1session_1_1App_html_a8e67b57829fe43a122a23c699b5de8fd"><div class="ttname"><a href="structipc_1_1session_1_1App.html#a8e67b57829fe43a122a23c699b5de8fd">ipc::session::App::m_name</a></div><div class="ttdeci">std::string m_name</div><div class="ttdoc">Brief application name, readable to humans and unique across all other applications' names; used both...</div><div class="ttdef"><b>Definition:</b> <a href="app_8hpp_source.html#l00144">app.hpp:144</a></div></div>
<div class="ttc" id="astructipc_1_1session_1_1App_html_a9e32297579603f2d96616976474d0246"><div class="ttname"><a href="structipc_1_1session_1_1App.html#a9e32297579603f2d96616976474d0246">ipc::session::App::m_user_id</a></div><div class="ttdeci">util::user_id_t m_user_id</div><div class="ttdoc">The application must run as this user ID (UID). Files and other shared resources shall have this owne...</div><div class="ttdef"><b>Definition:</b> <a href="app_8hpp_source.html#l00168">app.hpp:168</a></div></div>
<div class="ttc" id="astructipc_1_1session_1_1App_html_ae82a8635858664720c8546e468f8090b"><div class="ttname"><a href="structipc_1_1session_1_1App.html#ae82a8635858664720c8546e468f8090b">ipc::session::App::m_exec_path</a></div><div class="ttdeci">fs::path m_exec_path</div><div class="ttdoc">Absolute, lexically normalized canonical path to the executable entity (which is not a directory),...</div><div class="ttdef"><b>Definition:</b> <a href="app_8hpp_source.html#l00165">app.hpp:165</a></div></div>
<div class="ttc" id="astructipc_1_1session_1_1Client__app_html"><div class="ttname"><a href="structipc_1_1session_1_1Client__app.html">ipc::session::Client_app</a></div><div class="ttdoc">An App that is used as a client in at least one client-server IPC split.</div><div class="ttdef"><b>Definition:</b> <a href="app_8hpp_source.html#l00184">app.hpp:185</a></div></div>
<div class="ttc" id="astructipc_1_1session_1_1Server__app_html"><div class="ttname"><a href="structipc_1_1session_1_1Server__app.html">ipc::session::Server_app</a></div><div class="ttdoc">An App that is used as a server in at least one client-server IPC split.</div><div class="ttdef"><b>Definition:</b> <a href="app_8hpp_source.html#l00205">app.hpp:206</a></div></div>
<div class="ttc" id="astructipc_1_1session_1_1Server__app_html_a12df649b33893270afeac7240a571633"><div class="ttname"><a href="structipc_1_1session_1_1Server__app.html#a12df649b33893270afeac7240a571633">ipc::session::Server_app::m_allowed_client_apps</a></div><div class="ttdeci">Client_app_set m_allowed_client_apps</div><div class="ttdoc">A given Client_app (as identified by its distinct App::m_name) may request to establish an IPC sessio...</div><div class="ttdef"><b>Definition:</b> <a href="app_8hpp_source.html#l00222">app.hpp:222</a></div></div>
<div class="ttc" id="astructipc_1_1util_1_1Native__handle_html"><div class="ttname"><a href="structipc_1_1util_1_1Native__handle.html">ipc::util::Native_handle</a></div><div class="ttdoc">A monolayer-thin wrapper around a native handle, a/k/a descriptor a/k/a FD.</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8hpp_source.html#l00062">native_handle.hpp:63</a></div></div>
<div class="ttc" id="astructipc_1_1util_1_1Native__handle_html_a11bd62ce0a7bef4bdfe666201c26d4dc"><div class="ttname"><a href="structipc_1_1util_1_1Native__handle.html#a11bd62ce0a7bef4bdfe666201c26d4dc">ipc::util::Native_handle::null</a></div><div class="ttdeci">bool null() const</div><div class="ttdoc">Returns true if and only if m_native_handle equals S_NULL_HANDLE.</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8cpp_source.html#l00061">native_handle.cpp:61</a></div></div>
<div class="ttc" id="astructipc_1_1util_1_1Native__handle_html_ab2f496740139c5752a25a30cf3325d86"><div class="ttname"><a href="structipc_1_1util_1_1Native__handle.html#ab2f496740139c5752a25a30cf3325d86">ipc::util::Native_handle::m_native_handle</a></div><div class="ttdeci">handle_t m_native_handle</div><div class="ttdoc">The native handle (possibly equal to S_NULL_HANDLE), the exact payload of this Native_handle.</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8hpp_source.html#l00085">native_handle.hpp:85</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:26 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
